Class DiscountFreeGift

Description
Description | Vars (details)

This Class represents a dataobject for a DiscountFreeGift association. Only applicable when the Discount Type is 'fg' (free gift). Requires a Growth, Advanced, or Success plan.



    

  




  
  

    
Variable Summary

    

      Description |
      Vars (details)
    

    

      

        

          int
          $ProductId
        

        

          int
          $VariantId
        

        

          int
          $Amount
        

      

    

  



  
  

    
Variables

    

      Description |
      Vars
    

    

      
      


        

		
			int
			$ProductId
		
        

        
        
The product ID of the free gift. Must be an eligible product (no gift cards, bundles, or products with customizations).

      

      
      


        

		
			int
			$VariantId
		
        

        
        
The variant ID of the free gift. Required when the product has variants. Set to 0 to explicitly clear the variant (e.g. when switching to a product without variants).

      

      
      


        

		
			int
			$Amount
		
        

        
        
The quantity of the free gift product to add to the cart. Defaults to 1 if not provided.

      

  







  Documentation generated on Thu, 26 Jun 2026 12:00:00 +0000 by phpDocumentor 1.4.4